docs: add repository-local documentation index#3245
Open
ming1523 wants to merge 1 commit intoFuelLabs:masterfrom
Open
docs: add repository-local documentation index#3245ming1523 wants to merge 1 commit intoFuelLabs:masterfrom
ming1523 wants to merge 1 commit intoFuelLabs:masterfrom
Conversation
PR SummaryLow Risk Overview The index groups links to existing architecture, debugging, fee-calculation, and PoA materials, and also points to related contribution, deployment, and external node-operator resources. Written by Cursor Bugbot for commit 71539f3. This will update automatically on new commits. Configure here. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/README.mdindex for repository-local documentationWhy
The repository already contains useful documentation, but the
docs/directory does not currently have an index page to help contributors discover it. This small entrypoint mirrors the structure used by other node/infrastructure repositories where architecture, developer, and operator resources are easier to find.Validation
This is a docs-only change. The
no changeloglabel seems appropriate if maintainers agree.